home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / qbbs / twall100.zip / THEWALL.DOC < prev    next >
Text File  |  1990-12-15  |  12KB  |  337 lines
  1.  
  2.  
  3. The Wall of Last Words
  4. ------------------------------------------------------------------------
  5. (c) 1990 John Buetefuer - Midnight Innovations
  6.  
  7. This program is gauranteed to do nothing except take up drivespace. It
  8. works on my system as detailed below and should also on yours. But I
  9. accept no responsibility for any damage that may have been caused by
  10. this program. If left unregistered it is not designed to harm your
  11. system or stop working, you just miss out on all the great features it
  12. has to offer, and for only $10 I think it's a fair deal.
  13.  
  14.  
  15. A short(?) description of what it does and run-down of features
  16. ---------------------------------------------------------------
  17.  
  18. The Wall of Last Words (The Wall) is a log-off note door for Remote
  19. Access compatible BBS systems (any bbs that can create the dorinfo1.def
  20. file that RA/QBBS/RBBS creates). I have seen and used many other log-off
  21. note doors in the past but have found them all to be lacking in
  22. configurability and flexibility. So, The Wall was created.
  23.  
  24. TheWall may be configured to allow users to use an external full screen
  25. (QuickBBS/RA compatible) editor, or they may use TheWall's internal line
  26. editor. A quote last message function is also available with both the
  27. line editor and full screen editor. The maximum length of messages
  28. entered by users may also be selected by the sysop (between 1 and 99).
  29.  
  30. ! TheWall DOES NOT allow users to enter control codes in messages, so   !
  31. ! therefore there need be no worry about users entering such nasties as !
  32. ! ^KX's and ^X's into log-off notes.                                    !
  33. ! Valid characters are those with ascii codes 32 through to 255         !
  34.  
  35. Files included in this package
  36. ------------------------------
  37. THEWALL.EXE   The program that runs.
  38. THEWALL.DOC   This file you are looking at
  39. THEWALL.BAT   An example batch file of how to run it
  40. WALL.CFG      Example configuration file.
  41. PAUSE.ASC     Ascii file used in example config.
  42. PAUSE.ANS     Ansi file used in example config.
  43. TOPTXT.ASC    Ascii file used in example config.
  44. TOPTXT.ANS    Ansi file used in example config.
  45. HELP.ASC      Ascii &
  46. HELP.ANS      Ansi line editor user help text files.
  47.  
  48.  
  49. Running TheWall
  50. ---------------
  51.  
  52. TheWall has only one command line parameter, which is the full path and
  53. filename of the configuration file.
  54. eg
  55.  
  56. THEWALL C:\RA\DOORS\WALL\WALL.CFG
  57.  
  58. An exaple batch file is included in this archive to give you the general
  59. idea on how to run it. All you need to do then is have the BBS shell out
  60. and run the batch file. (I use an RA menu type 7 command on my system).
  61.  
  62. Running Multi-Node
  63. ------------------
  64.  
  65. If you wish to use TheWall in a multi-line system the method I recommend
  66. is the following. Set up your batch file similar to:
  67.  
  68. cd\ra\doors\wall
  69. TheWall c:\ra\doors\wall\wall%1.cfg
  70. exit
  71.  
  72. Then, when calling the batch file, pass the node number as parameter one
  73. ie "THEWALL.BAT 2" (node 2) and have a separate WALL.CFG made for each
  74. node. So for a 2 line system you would create WALL1.CFG for node one and
  75. WALL2.CFG for node two. This allows you to personalise each node, but,
  76. more importantly tell TheWall where to get the information files for
  77. each node.
  78.  
  79.  
  80. The Configuration file
  81. ----------------------
  82.  
  83. The config. file may take any name you desire, and may contain normal
  84. text providing that any COMMAND WORD does not appear as the first word on
  85. a line unless what follows are the correct parameters for that command.
  86.  
  87. COMMAND WORDS are words, that when used as the first word in the config.
  88. file tell TheWall to use the following information on that line to carry
  89. out a particular function. What follows is a complete list and
  90. description of commands words.
  91. NOTE: All functions marked with a (*) are available only when
  92. registered. For registration information, see the end of this file.
  93.  
  94.  
  95. InfoFiles
  96.  
  97.  The "InfoFiles" command word gives the path to DORINFO1.DEF and (but not
  98.  necessary) path to EXITINFO.BBS
  99.  DORINFO1.DEF is REQUIRED by TheWall, but EXITINFO.BBS is NOT required
  100.  for operation, thus making TheWall operable on other BBS systems that
  101.  support the DORINFO1.DEF standard.
  102.  eg.
  103.  
  104.  InfoFiles C:\RA
  105.  
  106.  
  107. Key           0
  108.  
  109.  This keyword passes your registration key number to the program which
  110.  enables TheWall's features that are not available in UnRegistered mode.
  111.  These features are marked with an asterisk (*). For information
  112.  regarding registration, see section at then end of this file.
  113.  
  114.  
  115. BBS
  116.  
  117.  After this command word the name of your BBS is expected to appear,
  118.  this name MUST be exactly as you request when you register TheWall,
  119.  otherwise the key will not work.
  120.  eg
  121.  
  122.  BBS Midnight Calller
  123.  
  124.  
  125. Sysop
  126.  
  127.  The sysops name is expected to appear after this command word, it must
  128.  be exactly as you request when you register TheWall otherwise the key
  129.  will not work.
  130.  eg.
  131.  
  132.  Sysop John Buetefuer
  133.  
  134.  
  135. FSE
  136.  
  137.  The first parameter for the "FSE" command can be either
  138.  1. ASK  : Will ask ansi users if they wish to use line editor or full
  139.            screen editor.
  140.  2. ANSI : Will give ALL ansi users the FSE if it is available.
  141.  3. EXIT : Will give ansi users the FSE to enter messages ONLY if they
  142.            have their FSE flag set in the EXITINFO.BBS file. If
  143.            EXITINFO.BBS is not available then TheWall defaults to ASK
  144.            mode.
  145.  The second parameter is the FULL PATH AND FILENAME to the Remote Access/QBBS
  146.  compatiable Full Screen Editor, if not given, or the editor is not found
  147.  then TheWall defaults to the line editor and will not ASK ansi users.
  148.  NOTE: the configuration files needed by the FSE may need to be in the
  149.  current directory, such is the case with QuickEd.
  150.  eg.
  151.  
  152.  FSE           Ask c:\ra\quicked.exe
  153.  
  154.  
  155. SaveName
  156.  
  157.  "SaveName" passes the name to save the completed note to, it should NOT
  158.  be given an extension as two versions are created name.ASC (ascii file)
  159.  name.ANS (ansi file) these files are then displayed by the BBS software
  160.  according to how the sysop sets up his/her system. For information
  161.  regarding Remote Access display files, consult RA.DOC.
  162.  eg.
  163.  
  164.  SaveName      C:\RA\TXTFILES\WELCOME1
  165.  
  166.  will save the note as WELCOME1.ASC and WELCOME1.ANS in the
  167.  C:\RA\TXTFILES directory.
  168.  
  169. TopTxt (*)
  170.  
  171.  This passes the name of a text file to be added to the TOP of the saved
  172.  note, before note text is inserted. No extension is given as TheWall
  173.  will look for .ASC and .ANS versions (ascii & ansi respectively) of the
  174.  file. If this file is NOT found, the default header text is added to
  175.  the top of the note. Remote Access/QBBS style control codes may be used in
  176.  this file with ^FA begin expanded to the users full name, ^FB the users
  177.  location, ^KI the current time in the system clock and ^KJ todays date.
  178.  If you wish other control codes to be added to the four above, please
  179.  contact me.
  180.  eg
  181.  
  182.  TopTxt        C:\RA\TXTFILES\TOPTXT
  183.  
  184.  will add the text in TOPTXT.ASC to the top of WELCOME1.ASC and text in
  185.  TOPTXT.ANS to the top of WELCOME1.ANS. Message text then follows.
  186.  
  187.  
  188. BottomTxt (*)
  189.  
  190.  This is the same as TopTxt but the text in the file specified is added
  191.  to the end of the saved note, after the message text.
  192.  eg.
  193.  
  194.  BottomTxt     C:\RA\TXTFILES\PAUSE
  195.  
  196.  will add the text in file PAUSE.ASC to the end of WELCOME1.ASC and text
  197.  in PAUSE.ANS to the end of WELCOME1.ANS. By putting a ^A at the end of
  198.  this file it will make RA/QBBS pause and wait for the user to hit the
  199.  enter key, allowing the user to read the message. If no file is
  200.  specified the default text will be put on the bottom of the note.
  201.  
  202.  
  203. HelpTxt (*)
  204.  
  205.  This command tells the line editor where to find both ascii and ansi
  206.  versions of the line editor help file. No extension is to be given as
  207.  TheWall will use the .ASC or .ANS version appropriately.
  208.  eg.
  209.  
  210.  HelpTxt       C:\RA\DOORS\WALL\HELP
  211.  
  212.  will make the editor display HELP.ASC to ascii users when they request
  213.  help, or HELP.ANS for ansi users.
  214.  
  215.  
  216. Log (*)
  217.  
  218.  This enables the saving of messages entered to a log file of which the
  219.  name you specify after the command word LOG. The users name, and
  220.  date/time of message creation is also placed with the message text.
  221.  eg
  222.  
  223.  Log           THEWALL.LOG
  224.  
  225.  will create a log file called THEWALL.LOG in the current directory.
  226.  
  227.  
  228. Quote (*)
  229.  
  230.  This command enables the previous message quoting function of TheWall.
  231.  If this function is enabled, each time a user enters a message and
  232.  saves it, a file called QUOTETMP will be created in the current
  233.  directory containing the text of the message, and the sysop selected
  234.  "quote string" appearing before each line of quoted text.
  235.  The Quote String is expected to preceed the Quote command word, it may
  236.  contain any characters you wish, but may not exceed 5 characters in
  237.  length. If spaces are required in the quote string, the quote string
  238.  may be enclosed in " characters (thus the only character unable to be
  239.  used in the quote string is the " char.). If a @ is found in the quote
  240.  string it is converted to the users initials.
  241.  eg.
  242.  
  243.  Quote "[@] "
  244.  
  245.  will produce a quoted line similar to :
  246.  [JB] Quoted text appears here
  247.  
  248.  
  249. MaxLength  (*)
  250.  
  251.  This sets the Maximum number of lines of MESSAGE TEXT that the user can
  252.  enter into the note. If user is using the line editor, it won't allow
  253.  them to enter more lines than this number. If using the FSE, only the
  254.  first <MaxLength> lines are saved in the note file. The maximum length
  255.  possible is 99 lines.
  256.  eg.
  257.  
  258.  MaxLength 15
  259.  
  260.  will only allow the user to enter 15 lines of text into the note.
  261.  NOTE, this function is unavailable in the UnRegistered version, the
  262.  maximum note length in the unregistered version is 10 lines.
  263.  
  264.  
  265. The following command words allow the sysop to modify the colours of the
  266. editor and colour of saved text (in the ansi file). All colours are
  267. represented by numbers, the numbers corresponding to each colour are the
  268. same as used in TheDraw(ansi file editor). NOTE, in the UnRegistered
  269. mode colours may not be altered, and the defaults are used.
  270.  
  271.  
  272. 0 - Black   4 - Red             8  - Dark Grey    12 - Light Red
  273. 1 - Blue    5 - Magenta         9  - Light Blue   13 - Light Magenta
  274. 2 - Green   6 - Yellow (Brown)  10 - Light Green  14 - Light Yellow
  275. 3 - Cyan    7 - Grey            11 - Light Cyan   15 - White
  276.  
  277.  
  278. TextClr       - Colour of text entry in line editor default =
  279.  
  280. MenuClr       - Colour of menu text in line editor default =
  281.  
  282. HotKeyClr     - Colour of hotkeys on line editor menu default =
  283.  
  284. CreditsClr    - Colour of LineEd (c) John Buetefuer etc etc default =
  285.  
  286. InfoClr       - Colour of info regarding number of lines etc default =
  287.  
  288. SaveTextClr   - Colour of text saved in ansi version of note default =
  289.  
  290. LineNumberClr - Colour of line numbers in line editor default =
  291.  
  292. PromptClr     - Colour of prompts in line editor default =
  293.  
  294.  
  295. Thats it for the configuration file, all command words are explained in
  296. the sample config. file included to make things easier to set up. The
  297. TopTxt and BottomTxt files mentioned above are also included so you can
  298. get the idea of how they work.
  299.  
  300.  
  301. REGISTRATION
  302. ------------
  303.  
  304. This program is ShareWare. I let it loose into the world, someone finds
  305. it useful and pays me a small amount for registering it. To register
  306. TheWall (and get access to all those other features that allow you to
  307. personalise it) it will cost you only $10 Australian. This way it's not
  308. going to hurt anyones wallet and I get some cash to help keep my BBS
  309. going.
  310.  
  311. REMEMBER, send me the name of the Sysop AND BBS that TheWall is being
  312. registered to.
  313.  
  314. All registration monies to be sent to:
  315.  
  316. John Buetefuer
  317. 6 Karyn cres
  318. Brahma Lodge
  319. S.A. 5109
  320. Australia
  321.  
  322. Cheques should be made out to John Buetefuer, and should be in AUSTRALIAN
  323. DOLLARS ONLY, as I'm not sure if my bank will exchange it for me.
  324.  
  325. If you have any questions or suggestions about TheWall I can be
  326. contacted by mail on the above address, or NetMail on one of the
  327. following addresses.
  328.  
  329. FidoNet  3:680/818
  330. SigNet   28:6100/101
  331. MultiNet 9:8546/1
  332. DragNet  23:810/1
  333.  
  334.  
  335. end of documentation.
  336.  
  337.